Creating and editing custom properties


	BlueCielo TeamWork 2012 Configuration Guide \| BlueCielo ECM Solutions

You are here: About property sets and properties > Creating and editing custom properties

Creating and editing custom properties

Custom properties can be arranged on custom property pages and the pages applied to document types . Users can then type property values on the property pages for documents and folders created from those types.

Warning Deleting a property makes the property and all of its existing data unavailable in the vault’s history. Only delete a property that you know will never be needed again. To retain a property for vault history but make it unavailable for future documents, clear the property for all objects on the Applies to page, but do not delete the property.

To create or edit a custom property:

In Configurator, expand Property Sets in the configuration tree to list the existing property sets. Expand the property set to which you want to add a new property or that contains the property that you want to edit or delete. The names of the properties currently in the selected property set appear.
To delete a property:

Select the property in the configuration tree and on the Edit menu, select Delete.

To edit a property, select the property in the configuration tree and click the Edit button to modify its property pages.
To create a new property, on the Edit menu, select New Property Definition. A new property appears in the configuration tree and empty property pages appear in the right pane.
Select or type options for the new property using the descriptions in the following table.

Custom property options
Option	Description
Display Name	Type a name that you want to appear in the TeamWork client applications.
Name	A default internal name is calculated. Accept the default in most cases.
Type	Select the data type for the new property. For more information about the available data types, see Configuring property data types.
Enable for scripting	Select this option to make this property available to VBScript expressions and Visual Basic extensions. For more information, see Configuring properties for use with Visual Basic and VBScript.
VBScript name	A default name is calculated for the property to be used in VBScript expressions. Accept the default in most cases. For more information, see Configuring properties for use with Visual Basic and VBScript.
Include in Key Find	Key Find is a fast, sorted search for values of one property only. It is described in detail in the BlueCielo TeamWork User’s Guide. You can configure any string type property to be indexed for Key Find. Select this option to make this property selectable in Key Find searches. Note The Enable for scripting option must be selected and Name for scripting must be complete for the Include in Key-Find option to be active.
Value separator	Type a separator character to delimit multiple values selected from a lookup list or table. We recommend the semicolon (;) character. If any value is typed for this option, it causes the property to appear as a drop-down combobox control on property pages from which users may select multiple values. The selected values will then appear as a single string delimited by this character. For this option to work correctly, the following restrictions apply: The property’s Type option must be set to String. The property’s Select a value from option the on its Validation page must specify the values to show in the combobox control. Users must have the Get values privilege to any tables specified for the Select a value from option. Note The combined length of selected values and separator characters are limited to the String data type maximum of 255 characters. Note To create multi-value data without the TeamWork combobox control (for example, in a database for import into a vault or with the Set Property Value command), you must use the same separator character as specified here regardless of the locale setting of the computer. This is true for all properties, not just multi-value properties. Warning Do not change the separator character after it has already been used by some documents. Doing so will cause incorrect values the next time that the document’s properties are edited.

Click the OK button to save your changes.

You may now add the property to a custom property page, as described in Creating and editing panel elements.

Related concepts

About property sets and properties

Understanding the internal property sets